Aminet 15/Aminet 15 - Nov 1996.iso/Aminet/dev/misc/BST_SystemDocs.lha/BeastV1/Docs/ROBO_Docs/Methods.doc

Text File | 1996-09-03 | 9.7 KB | 455 lines

TABLE OF CONTENTS
0001 BFS/OBM_BFSINPUT
0002 BFS/OBM_BFSOUTPUT
0003 BeaMM/OBM_BEAMMINPUT
0004 BeaMM/OBM_BEAMMOUTPUT
0005 BeaVis/OBM_BVSINPUT
0006 BeaVis/OBM_BVSOUTPUT
0007 BeaVis/OBM_IDCMPINPUT
0008 BeaVis/OBM_IDCMPOUTPUT
0009 Beast/OBM_ALLOCMEM
0010 Beast/OBM_CONTENTSINPUT
0011 Beast/OBM_CONTENTSOUTPUT
0012 Beast/OBM_DISPOSE
0013 Beast/OBM_FREEMEM
0014 Beast/OBM_GETATTR
0015 Beast/OBM_INIT
0016 Beast/OBM_INPUT
0017 Beast/OBM_INPUT2
0018 Beast/OBM_INPUT3
0019 Beast/OBM_INPUT4
0020 Beast/OBM_LOCKMEM
0021 Beast/OBM_OUTPUT
0022 Beast/OBM_OUTPUT2
0023 Beast/OBM_OUTPUT3
0024 Beast/OBM_OUTPUT4
0025 Beast/OBM_SETATTR
0026 Beast/OBM_SYSINPUT
0027 Beast/OBM_SYSOUTPUT
0028 Beast/OBM_UNLOCKMEM
0029 Beast/OBM_UPDATE
0030 Beast/OBM_local0
0031 Beast/OBM_local0
0032 Beast/OBM_local1
0033 Beast/OBM_local2
0034 BeastSystem/OBM_ADDEVENT
0035 BeastSystem/OBM_EVENTLOOP
0036 BeastSystem/OBM_FOREACH
0037 BeastSystem/OBM_REMEVENT
0038 MethodFlags/MTHF_BREAK
0039 MethodFlags/MTHF_DOCHILDREN
0040 MethodFlags/MTHF_DOPARENTS
0041 MethodFlags/MTHF_ERROR
0042 MethodFlags/MTHF_FATALERROR
0043 MethodFlags/MTHF_PASSTOCHILD
0044 MethodFlags/MTH_B52_bits
0045 Methods/Methods
0046 Methods/OBM_bits_FAMILY
BFS/OBM_BFSINPUT

NAME
      OBM_BFSINPUT -- (under construction)

BFS/OBM_BFSOUTPUT

NAME
      OBM_BFSOUTPUT -- (under construction)

BeaMM/OBM_BEAMMINPUT

NAME
      OBM_BEAMMINPUT -- (under construction)

BeaMM/OBM_BEAMMOUTPUT

NAME
      OBM_BEAMMOUTPUT -- (under construction)

BeaVis/OBM_BVSINPUT

NAME
      OBM_BVSINPUT -- (under construction)

BeaVis/OBM_BVSOUTPUT

NAME
      OBM_BVSOUTPUT -- (under construction)

BeaVis/OBM_IDCMPINPUT

NAME
      OBM_IDCMPINPUT -- IDCMP input method. (under construction)

BeaVis/OBM_IDCMPOUTPUT

NAME
      OBM_IDCMPOUTPUT -- IDCMP output method. (under construction)

Beast/OBM_ALLOCMEM

NAME
      OBM_ALLOCMEM -- Allocate memory. (V1 Bravo)

FUNCTION
      See mth_AllocMem_BeastLibrary for the general behaviour.

Beast/OBM_CONTENTSINPUT

NAME
      OBM_CONTENTSINPUT -- (V1 Charlie)

FUNCTION
      The object is 'fed' with a BTA_MemBlock and BTA_MemSize tag.
      The object will 'copy' the contents (BTA_MemBlock) to it's
      contents.

SEE ALSO
      OBM_CONTENTSOUTPUT

Beast/OBM_CONTENTSOUTPUT

NAME
      OBM_CONTENTSOUTPUT -- (V1 Charlie)

FUNCTION
      The object will 'output' using the OBJ_ToOutput function
      it's contents. The taglist must contain the BTA_MemBlock
      and BTA_MemSize tags.

INPUTS
      TagList which may contain the following tags.
        BTA_MemBlock -
            Pointer to which the data must be written.
        BTA_Pointer - retrieved from this method or NULL.
        BTA_Flags -
          CONTENTSOUTPUT_FULL
            Complete dump in one big block.
          CONTENTSOUTPUT_FIXED
            Dump a block size BTA_MemSize.
          CONTENTSOUTPUT_UNTILBYTE
            Dump block until BTA_ByteNumber is reached.
          CONTENTSOUTPUT_UNTILWORD
            Dump block until BTA_WordNumber is reached
          CONTENTSOUTPUT_UNTILLONG
            Dump block until BTA_LongNumber is reached
          CONTENTSOUTPUT_END
            End the transfer.
        BTA_MemSize -
        BTA_ByteNumber -
        BTA_WordNumber -
        BTA_LongNumber -


RESULT
      OBJ_ToOutput with a TagList containing at least the following tags.
        BTA_MemBlock
        BTA_MemSize
        BTA_Pointer - this tag must be used again when the method
                  is called again.


SEE ALSO
      OBM_CONTENTSINPUT

Beast/OBM_DISPOSE

NAME
      OBM_DISPOSE -- General dispose method. (V1 Alpha)

FUNCTION
      This method must free all allocated resources of the object.

Beast/OBM_FREEMEM

NAME
      OBM_FREEMEM -- Free memory. (V1 Bravo)

FUNCTION
      See mth_FreeMem_BeastLibrary for the general behaviour.

Beast/OBM_GETATTR

NAME
      OBM_GETATTR -- General method to get instance fields. (V1 Alpha)

FUNCTION
      OBM_INIT, OBM_SETATTR and OBM_GETATTR are all using the BTA_NumberOf
      tag to find out how many tags must be processed. This tag however is
      not required, but the    methods will run more efficient with it.
      The BST_FillAttrTagList also use the BTA_NumberOf tag.

Beast/OBM_INIT

NAME
      OBM_INIT -- General init method. (V1 Alpha)

FUNCTION
      TagList requirements equals the OBM_SETATTR method.

Beast/OBM_INPUT

NAME
      OBM_INPUT -- General input method 0. (V1 Alpha)

Beast/OBM_INPUT2

NAME
      OBM_INPUT2 -- General input method 2. (V1 Alpha)

Beast/OBM_INPUT3

NAME
      OBM_INPUT3 -- General input method 3. (V1 Alpha)

Beast/OBM_INPUT4

NAME
      OBM_INPUT4 -- General input method 4. (V1 Alpha)

Beast/OBM_LOCKMEM

NAME
      OBM_LOCKMEM -- Lock memory. (V1 Bravo)

FUNCTION
      See mth_LockMem_BeastLibrary for the general behaviour.

Beast/OBM_OUTPUT

NAME
      OBM_OUTPUT -- General output method 0. (V1 Alpha)

Beast/OBM_OUTPUT2

NAME
      OBM_OUTPUT2 -- General output method 2. (V1 Alpha)

Beast/OBM_OUTPUT3

NAME
      OBM_OUTPUT3 -- General output method 3. (V1 Alpha)

Beast/OBM_OUTPUT4

NAME
      OBM_OUTPUT4 -- General output method 4. (V1 Alpha)

Beast/OBM_SETATTR

NAME
      OBM_SETATTR -- General method to set instance fields. (V1 Alpha)

FUNCTION
      This method must always been used to set the attributes of an object.
      See OBM_GETATTR for more information.

Beast/OBM_SYSINPUT

NAME
      OBM_SYSINPUT -- BEAST system input, do not use this method. (V1 Alpha)

Beast/OBM_SYSOUTPUT

NAME
      OBM_SYSOUTPUT -- BEAST system output, do not use this method. (V1 Alpha)

Beast/OBM_UNLOCKMEM

NAME
      OBM_UNLOCKMEM -- Unlock memory. (V1 Bravo)

FUNCTION
      See mth_UnlockMem_BeastLibrary for the general behaviour.

Beast/OBM_UPDATE

NAME
      OBM_UPDATE -- General method to update an object. (under construction)

Beast/OBM_local0

NAME
      OBM_local0 -- Local method slot 0. (V1 Alpha)


FUNCTION
      Defines a slot OBM_local0 .. OBM_local0 + 0x40


Beast/OBM_local0

NAME
      OBM_local3 -- Local method slot 3. (V1 Alpha)


FUNCTION
      Defines a slot OBM_local3 .. OBM_local3 + 0x1000000


Beast/OBM_local1

NAME
      OBM_local1 -- Local method slot 1. (V1 Alpha)


FUNCTION
      Defines a slot OBM_local1 .. OBM_local1 + 0x700


Beast/OBM_local2

NAME
      OBM_local2 -- Local method slot 2. (V1 Alpha)


FUNCTION
      Defines a slot OBM_local2 .. OBM_local2 + 0x1000


BeastSystem/OBM_ADDEVENT

NAME
      OBM_ADDEVENT -- Add an event. (V1 Bravo)

FUNCTION
      See mth_AddEvent_BST_Application for an example.
      BTA_MainObject    - af[R]
        The event of this object is removed.

BeastSystem/OBM_EVENTLOOP

NAME
      OBM_EVENTLOOP -- Enter the eventloop. (V1 Bravo)

FUNCTION
      See mth_EventLoop_BST_Application for an example.

BeastSystem/OBM_FOREACH

NAME
      OBM_FOREACH -- For each object do .... (V1 Bravo)

FUNCTION
      See mth_ForEach_BeastLibrary for the general behaviour.

BeastSystem/OBM_REMEVENT

NAME
      OBM_REMEVENT -- Remove event. (V1 Bravo)

FUNCTION
      See mth_RemEvent_BST_Application for an example.
      BTA_MainObject    - af[R]
        The event of this object is removed.

MethodFlags/MTHF_BREAK

NAME
      MTHF_BREAK -- (V1 Alpha)

FUNCTION
      Don't execute the method, this flag is mostly used by superclasses.
      (Method overriding).

MethodFlags/MTHF_DOCHILDREN

NAME
      MTHF_DOCHILDREN -- (V1 Alpha)

FUNCTION
      Delegate method through childern bottom up.
      The method is first triggered at the 'lowest'
      object in the tree, those with no children.

MethodFlags/MTHF_DOPARENTS

NAME
      MTHF_DOPARENTS -- (V1 Alpha)

FUNCTION
      Delegate method through the parent objects.
      The method is also triggered at the parent objects
      this will continue until one method routine resets this flag.

MethodFlags/MTHF_ERROR

NAME
      MTHF_ERROR -- (V1 Alpha)

FUNCTION
      There has occured an error, but it is not
      fatal. If the object has the OBM_ERROR method
      implemented this can be used to find out what went wrong.

MethodFlags/MTHF_FATALERROR

NAME
      MTHF_FATALERROR -- (V1 Alpha)

FUNCTION
      There has occured a fatal error. Mostly this means that the object is
      instable.

MethodFlags/MTHF_PASSTOCHILD

NAME
      MTHF_PASSTOCHILD -- (V1 Alpha)

FUNCTION
      Delegate method through children top down.
      Now the method is triggered first at the childern.
      A method can reset this flag to prevent it's children being called.

MethodFlags/MTH_B52_bits

NAME
      MTH_B52_bits -- (under construction)

FUNCTION
      The mask of the bits which are defined by B52.

Methods/Methods

NAME
      Introduction -- Method definitions. (V1 Bravo)


FUNCTION
      Local methods, these method id's may be use by classes to define their own
      private methods, special care must be taken when doing so. Delegation of
      these throughout the parents or children can be dangerious, this because
      of BEAST is a dynamic system and therefore it is possible that several
      'other' objects are inserted. And there could be a conflict because classes
      have the same method id defined for other uses.
      When developers are defining their own classes they can ask for a pre-
      defined 'slot' of methods which they can use. Send a message to
      [e-mail].
      Developers however are strongly recommended to use the standard BEAST methods.
      In this way the classes have a similiar behaviour.

      Now the general implementation of the BEAST methods is given, please note that
      this is _only_ the general description. These are the minimum demands
      the method must comply to. Every class can give a different implementation
      to the method as long as the general description is maintained.


Methods/OBM_bits_FAMILY

NAME
      OBM_bits_FAMILY -- The bits which defines the family to which the methods
                 belong. (V1 Bravo)


FUNCTION
      OBM_type_Plain   = General methods.
      OBM_type_System  = Methods defined by the BEAST system (BeastLibrary), and
                   by the BEAST system classes.
      OBM_type_General = Methods defined by the BEAST general classes.
      OBM_type_B52       = Methods defined by B52/BEAST classes.
      OBM_type_BeaVis  = Methods defined by BeaVis.
      OBM_type_BFS       = Methods defined by BFS (Beast FileSystem) classes.
      OBM_type_BeaMM   = Methods defined by BeaMM (Beast MultiMedia) classes.
      OBM_type_BEASTAR = Methods defined by BEASTAR classes.